Skip to content

docs: update Homebrew installation instructions for Stretchly#1787

Open
fernandascovino wants to merge 1 commit into
hovancik:trunkfrom
fernandascovino:patch-1
Open

docs: update Homebrew installation instructions for Stretchly#1787
fernandascovino wants to merge 1 commit into
hovancik:trunkfrom
fernandascovino:patch-1

Conversation

@fernandascovino
Copy link
Copy Markdown

Removed the --no-quarantine flag from the Homebrew installation command and added a note for macOS users regarding Gatekeeper.

Issue: N/A (Minor documentation update)

Requirements

  • Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
  • issue was opened to discuss proposed changes before starting implementation. It is important do discuss changes before implementing them (Why should we add it? How should it work? How should it look? Where will it be? ...).
  • during development, node version specified in package.json was used (ie using nvm).
  • package versions and package-lock.json were not changed (npm install --no-save).
  • app version number was not changed.
  • all new code has tests to ensure against regressions.
  • npm run lint reports no offenses.
  • npm run test is error-free.
  • README and CHANGELOG were updated accordingly.
  • after PR is approved, all commits in it are squashed

Note on unchecked boxes: I left some boxes unchecked because this is strictly a documentation update to the README.md file. No application code, dependencies, or test suites were modified, and an issue was not opened prior since this is a quick fix for a broken installation command.

Description of the Change

Homebrew recently disabled the --[no-]quarantine switch. As a result, users attempting to install Stretchly using the command currently provided in the README encounter the following error:
Error: Calling the --[no-]quarantine switch is disabled! There is no replacement.

This PR fixes the documentation by:

  1. Removing the deprecated --no-quarantine flag from the Homebrew installation command.
  2. Adding a note specifically for macOS users explaining that Gatekeeper may block the app on its first launch (due to the missing flag) and providing the standard instructions to bypass it via System Settings > Privacy & Security.

Verification Process

  • Ran the updated brew install --cask hovancik/stretchly/stretchly command locally on macOS to verify it successfully downloads and installs the app without throwing the Homebrew switch error.
  • Verified that launching the newly installed app triggers the expected macOS Gatekeeper "unidentified developer" prompt.
  • Followed the documented steps (System Settings > Privacy & Security > Open Anyway) to ensure the bypass instructions are accurate and work correctly on recent macOS versions.
  • Previewed the README.md markdown changes to ensure correct formatting and readability.

Other information

This is a documentation-only pull request aimed at improving the onboarding experience for new macOS users.

Removed the --no-quarantine flag from the Homebrew installation command and added a note for macOS users regarding Gatekeeper.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant